Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Online DDL: detect vreplication errors via vreplication_log history #16925

Merged
merged 3 commits into from
Oct 21, 2024
Merged

Online DDL: detect vreplication errors via vreplication_log history #16925

merged 3 commits into from
Oct 21, 2024

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Oct 10, 2024 •
edited
Loading

Description

Today, vreplication based Online DDL reads _vt.vreplication table, and uses state and message columns as indicators to errors.

However, these columns, even if there's a terminal error, can be overwritten and shadowed by later changes to vreplication state, as described in #16924.

Thankfully, _vt.vreplication_log persists all states and messages throughout the workflow's lifetime. In this PR, Online DDL ensures to search for error-indicating states/messages in _vt.vreplication_log. If found, these are picked and used by Online DDL to determine that the migration is broken, and advertised forward in _vt.schema_migrations.message.

We furthermore prepend:

  • terminal error: prefix for terminal errors in vreplication.
  • vreplication: prefix for schema_migrations error messages originating by vreplication.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@shlomi-noach shlomi-noach added Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) labels Oct 10, 2024
@shlomi-noach shlomi-noach requested a review from a team October 10, 2024 10:55
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 10, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 10, 2024
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 10, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 10, 2024
@shlomi-noach shlomi-noach mentioned this pull request Oct 10, 2024
Closed
@shlomi-noach
adapt test
0b48df5 
Signed-off-by: Shlomi Noach <[email protected]>
@codecov Codecov
Copy link

codecov bot commented Oct 10, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 5.00000% with 19 lines in your changes missing coverage. Please review.

Project coverage is 67.15%. Comparing base (d75272c) to head (63ef171).
Report is 31 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/onlineddl/executor.go 0.00% 19 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #16925      +/-   ##
==========================================
- Coverage   69.40%   67.15%   -2.26%     
==========================================
  Files        1570     1571       +1     
  Lines      203846   251782   +47936     
==========================================
+ Hits       141488   169082   +27594     
- Misses      62358    82700   +20342

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mattlord
mattlord approved these changes Oct 11, 2024
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! It's nice to see the _vt.vreplication_log table being put to good use ❤️

go/vt/vttablet/tabletmanager/vreplication/controller.go Outdated
@@ -305,7 +305,7 @@ func (ct *controller) runBlp(ctx context.Context) (err error) {
if (err != nil && vr.WorkflowSubType == int32(binlogdatapb.VReplicationWorkflowSubType_AtomicCopy)) ||
isUnrecoverableError(err) ||
!ct.lastWorkflowError.ShouldRetry() {

err = vterrors.Wrapf(err, "terminal error")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth making terminal error an exported const IMO. Then that can be used in the query as well: OR locate ('terminal error:', message) = 1 and in the unit test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've parameterized the string, using the parameter in creation and in SQL. However, in unit tests I'm still using the hard coded text because I think it makes the unit test clearer.

@shlomi-noach
parameterize 'terminal error'
63ef171 
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach shlomi-noach requested a review from a team October 20, 2024 11:36
@rohit-nayak-ps rohit-nayak-ps merged commit 327142d into vitessio:main Oct 21, 2024
98 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the onlineddl-vrepl-log-error-history branch October 21, 2024 06:57
@shlomi-noach
Copy link
Contributor Author

Related: #17264

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@mattlord mattlord mattlord approved these changes

Assignees
No one assigned
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Component: VReplication Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: retain important vreplication messages
3 participants
@shlomi-noach @mattlord @rohit-nayak-ps